Interface RoutingProcess

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
RoutingProcessv6
All Known Implementing Classes:
RoutingProcessImpl, RoutingProcessv6Impl

public interface RoutingProcess extends Process
Information provided by the PKI file:

    \class RoutingProcess
    
    \brief RoutingProcess handles and manipulates the static routing.
    
    \example network().getDevice("Router0").getProcess("RoutingProcess")
    
Author:
Auto-generated
  • Method Details

    • clearAllRoutes

      void clearAllRoutes()
      Information provided by the PKI file:
      
          \brief Clears all routes.
          
              
    • clearRoute

      void clearRoute(IPAddress networkId, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Clears the specified route.
          
          \param networkId, the network address of interest.
          \param mask, the network mask of interest.
          
              
      Parameters:
      networkId - Takes in a parameter of networkId
      mask - Takes in a parameter of mask
    • addStaticRoute

      boolean addStaticRoute(IPAddress ipAddress, IPAddress subnetMask, IPAddress nextHop, String portName, int adminDistance)
      Information provided by the PKI file:
      
          \brief Adds a static route.
          
          \param ipAddress, the network address.
          \param subnetMas, the network mask.
          \param nextHop, the next hop address.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      subnetMask - Takes in a parameter of subnetMask
      nextHop - Takes in a parameter of nextHop
      portName - Takes in a parameter of portName
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • removeStaticRoute

      boolean removeStaticRoute(IPAddress ipAddress, IPAddress subnetMask, IPAddress nextHop, String portName, int adminDistance)
      Information provided by the PKI file:
      
          \brief Removes the specified static route.
          
          \param ipAddress, the network address.
          \param subnetMas, the network mask.
          \param nextHop, the next hop address.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          \param adminDistance, the administrative distance value.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
      subnetMask - Takes in a parameter of subnetMask
      nextHop - Takes in a parameter of nextHop
      portName - Takes in a parameter of portName
      adminDistance - Takes in a parameter of adminDistance
      Returns:
      boolean Returns a boolean
    • getStaticRouteCount

      int getStaticRouteCount()
      Information provided by the PKI file:
      
          \brief Returns the number of static routes.
          
          \return int, the number of static routes.
          
              
      Returns:
      int Returns a int
    • getStaticRouteAt

      StaticRoute getStaticRouteAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the static route at the specified index.
          
          \param index, the index of the static route of interest.
          
          \return StaticRoute, the StaticRoute object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      StaticRoute Returns a StaticRoute
    • getRoutingTable

      RoutingTable getRoutingTable()
      Information provided by the PKI file:
      
          \brief Returns the routing table.
          
          \return RoutingTable, the RoutingTable object.
          
              
      Returns:
      RoutingTable Returns a RoutingTable